<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.13.1: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

.subscript {
  vertical-align: sub;
  font-size: smaller }

.superscript {
  vertical-align: super;
  font-size: smaller }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
}

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left, table.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right, table.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

table.align-center {
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit }

/* div.align-center * { */
/*   text-align: left } */

.align-top    {
  vertical-align: top }

.align-middle {
  vertical-align: middle }

.align-bottom {
  vertical-align: bottom }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em ;
  margin-right: 2em }

pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
  border: 0px;
  border-top: 2px solid;
  border-bottom: 2px solid;
  border-collapse: collapse;
}
table.docutils.booktabs * {
  border: 0px;
}
table.docutils.booktabs th {
  border-bottom: thin solid;
  text-align: left;
}

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document">


<!-- -*- Mode: rst -*- -->
<!-- -*- Mode: rst -*- -->
<!-- |CodeReviewUrl|
|CodeReviewHomePage|_
|CodeReviewDoc|_
|CodeReview@github|_
|CodeReview@readthedocs|_
|CodeReview@readthedocs-badge|
|CodeReview@pypi|_ -->
<!-- .. _CodeReview@github: https://github.com/FabriceSalvaire/CodeReview -->
<!-- .. _CodeReview@readthedocs: http://CodeReview.readthedocs.org -->
<!-- .. _CodeReview@pypi: https://pypi.python.org/pypi/CodeReview -->
<!-- End -->
<!-- -*- Mode: rst -*- -->
<div class="section" id="codereview">
<h1>CodeReview</h1>
<p><a class="reference external" href="https://pypi.python.org/pypi/CodeReview"><object data="https://img.shields.io/pypi/l/CodeReview.svg" type="image/svg+xml">CodeReview license</object></a>
<a class="reference external" href="https://pypi.python.org/pypi/CodeReview"><object data="https://img.shields.io/pypi/pyversions/CodeReview.svg" type="image/svg+xml">CodeReview python version</object></a></p>
<p><a class="reference external" href="https://pypi.python.org/pypi/CodeReview"><object data="https://img.shields.io/pypi/v/CodeReview.svg" type="image/svg+xml">CodeReview last version</object></a></p>
<!-- * Quick Link to `Production Branch <https://github.com/FabriceSalvaire/CodeReview/tree/master>`_
* Quick Link to `Devel Branch <https://github.com/FabriceSalvaire/CodeReview/tree/devel>`_ -->
<p>CodeReview Home Page is located at <a class="reference external" href="http://fabricesalvaire.github.io/CodeReview">http://fabricesalvaire.github.io/CodeReview</a></p>
<img alt="https://raw.github.com/FabriceSalvaire/CodeReview/master/doc/sphinx/source/images/code-review-log.png" src="https://raw.github.com/FabriceSalvaire/CodeReview/master/doc/sphinx/source/images/code-review-log.png" />
<img alt="https://raw.github.com/FabriceSalvaire/CodeReview/master/doc/sphinx/source/images/code-review-diff.png" src="https://raw.github.com/FabriceSalvaire/CodeReview/master/doc/sphinx/source/images/code-review-diff.png" />
<div class="section" id="credits">
<h2>Credits</h2>
<p>Authors: <a class="reference external" href="http://fabrice-salvaire.fr">Fabrice Salvaire</a></p>
</div>
<div class="section" id="news">
<h2>News</h2>
<!-- -*- Mode: rst -*- -->
<!-- no title here -->
</div>
<div class="section" id="v1-2017-12-20">
<h2>V1 2017-12-20</h2>
<ul class="simple">
<li>Redesigned INotify support</li>
</ul>
<!-- -*- Mode: rst -*- -->
</div>
</div>
<div class="section" id="introduction">
<h1>Introduction</h1>
<p>The aim of CodeReview is to provide tools for code review tasks on local Git repositories.  As
opposite to software like <a class="reference external" href="https://www.gerritcodereview.com">Gerrit</a> for example, CodeReview is
not designed to perform code review at a team level, but to check the stage before a commit and show
the difference between two versions.  In particular, CodeReview fills the gap with IDEs that don't
provide efficiently these features.</p>
<div class="section" id="how-to-use-codereview">
<h2>How to use CodeReview ?</h2>
<p>CodeReview provides two applications <em>pyqgit</em> and <em>diff-viewer</em>.</p>
<!-- -*- Mode: rst -*- -->
</div>
</div>
<div class="section" id="features">
<h1>Features</h1>
<p>The main features of CodeReview are:</p>
<blockquote>
<ul class="simple">
<li>display and browse the log and paches of a Git repository</li>
<li>diff side by side using Patience algorithm</li>
<li>watch for file system changes</li>
</ul>
</blockquote>
<p>Diff viewer features:</p>
<blockquote>
<ul class="simple">
<li>stage/unstage file</li>
<li>number of context lines</li>
<li>font size</li>
<li>line number mode</li>
<li>align mode</li>
<li>complete mode</li>
<li>highlight mode</li>
</ul>
</blockquote>
</div>
<div class="section" id="installation">
<span id="installation-page"></span><h1>Installation</h1>
<div class="section" id="on-fedora">
<h2>On Fedora</h2>
<p>RPM packages are available for the Fedora distribution on <a class="reference external" href="https://copr.fedorainfracloud.org/coprs/fabricesalvaire/code-review">https://copr.fedorainfracloud.org/coprs/fabricesalvaire/code-review</a></p>
<p>Run these commands to enable the copr repository and install the last release:</p>
<pre class="code sh literal-block">
dnf copr <span class="name builtin">enable</span> fabricesalvaire/code-review
dnf install CodeReview
</pre>
</div>
<div class="section" id="from-pypi-repository">
<h2>From PyPi Repository</h2>
<p>CodeReview is available on <a class="reference external" href="https://pypi.python.org/pypi">PyPI</a> repository: <a class="reference external" href="https://pypi.python.org/pypi/CodeReview">https://pypi.python.org/pypi/CodeReview</a></p>
<p>Run this command to install the last release:</p>
<pre class="code sh literal-block">
pip install CodeReview
</pre>
<p>Notice, it requires Python 3 and a C compiler.</p>
</div>
<div class="section" id="from-source">
<h2>From source</h2>
<p>CodeReview source code is hosted at <a class="reference external" href="https://github.com/FabriceSalvaire/CodeReview">https://github.com/FabriceSalvaire/CodeReview</a></p>
<p>Clone the Git repository using this command:</p>
<pre class="code sh literal-block">
git clone git&#64;github.com:FabriceSalvaire/CodeReview.git
</pre>
<p>Then build and install CodeReview using these commands:</p>
<pre class="code sh literal-block">
python setup.py build
python setup.py install
</pre>
</div>
<div class="section" id="dependencies">
<h2>Dependencies</h2>
<p>CodeReview requires the following dependencies:</p>
<ul class="simple">
<li><a class="reference external" href="http://python.org">Python</a> 3 (at least v3.4)</li>
<li><a class="reference external" href="http://www.pygit2.org/install.html">pygit2</a> and libgit2 see <a class="reference external" href="http://www.pygit2.org/install.html#quick-install">link</a>  for installation instruction</li>
<li>Pygments</li>
<li><a class="reference external" href="http://www.riverbankcomputing.com/software/pyqt/download5">PyQt5</a></li>
<li>PyYAML</li>
<li>A C compiler to compile a module</li>
</ul>
</div>
</div>
<div class="section" id="how-to-help">
<h1>How to help</h1>
<ul class="simple">
<li>test it on Windows and OSX</li>
<li>fix bugs: look at issues</li>
<li>sometime pyqgit is slow: profile code to find issues</li>
</ul>
</div>
</div>
</body>
</html>
